apr
系统.对象
└apr.文件操作
本类提供了文件流及相关操作的方法。
| 数据成员摘要 | |
|---|---|
| 公开 静态 常量 整数 | 块数据最大长度 = 1024 块数据最大长度。 |
| 初始化方法摘要 | |
|---|---|
| 公开 | 初始化(文本 文件名, 整数 标志, 整数 权限, apr.内存池 内存池对象) 打开指定文件，本方法设置返回码。 |
| 公开 | 初始化() |
| 方法摘要 | |
|---|---|
| 公开 apr.返回码 | 打开(文本 文件名, 整数 打开标志, 整数 权限, apr.内存池 内存池对象) 打开指定文件。 |
| 公开 apr.返回码 | 关闭() 关闭己打开文件。 |
| 公开 静态 apr.返回码 |
删除指定文件。 |
| 公开 静态 apr.返回码 | 重命名(文本 源文件名, 文本 目的文件名, apr.内存池 内存池对象) 对指定文件重命名。 |
| 公开 静态 apr.返回码 | 复制(文本 源文件名, 文本 目的文件名, 整数 权限, apr.内存池 内存池对象) 复制文件，如果目的文件不存在将创建新文件。 |
| 公开 静态 apr.返回码 | 追加(文本 源文件名, 文本 目的文件名, 整数 权限, apr.内存池 内存池对象) 将源文件内容追加到目的文件中，如果目的文件不存在将创建新文件。 |
| 公开 apr.返回码 | 是否到文件尾() 如果到文件尾，返回枚举“返回值选项”的“EOF”，否则返回“SUCCESS”。 |
| 公开 apr.返回码 | |
| 公开 apr.返回码 | |
| 公开 apr.返回码 | |
| 公开 字节集 | 读入(整数 读取长度) 如果使用本方法读入大量的数据。如果到文件尾，返回枚举“返回值选项”的“EOF”。本方法设置返回码，成功返回读取的字节集，失败返回空字节集。 |
| 公开 整数 | 写出(字节集 字节集对象) 如果使用本方法写出大量的数据。本方法设置返回码，本方法成功返回已写出长度（单位为字节），失败返回-1。 |
| 公开 整数 | 写出块数据(字节集[] 块数据) 本方法可以写出多个缓冲区，也称为集中写，本方法设置返回码，成功返回已写出长度（单位为字节），失败返回-1。 |
| 公开 字节集 | 读入全部(整数 长度) 本方法与“读入”方法类似，支持读入大量的数据。本方法设置返回码，成功返回已读字节集，失败返回空字节集。 |
| 公开 整数 | 写出全部(字节集 字节集对象) 本方法与“写出”方法类似，支持写出大量的数据。本方法设置返回码，成功返回已写出长度（单位为字节），失败返回-1。 |
| 公开 整数 | 写出全部块数据(字节集[] 块数据) 支持写出大量数据和多个缓冲区。本方法设置返回码，成功返回已写出长度（单位为字节），失败返回-1。 |
| 公开 apr.返回码 | 写出字符(整数 ASCII码) |
| 公开 整数 | 读入字符() 本方法设置返回码，成功返回读入字符的ASCII码，失败返回-1。 |
| 公开 apr.返回码 | 返回至流(整数 ASCII码) 将指定字符返回给流，下次读入时首先读入该字符。 |
| 公开 apr.返回码 | 刷新流() 本方法常用于输出流（以写打开的文件或标准输出流），它将输出该流的缓冲区所有未写出的数据；如果输出流文件操作对象创建后未打开任何流，那么可能导致所有输出流被刷新；如针对输入流情况是未知的。 |
| 公开 静态 apr.返回码 | 复制对象(apr.文件操作 目的文件操作对象, apr.文件操作 源文件操作对象, apr.内存池 内存池对象) 复制参数“源文件操作对象”为“目的文件操作对象”，即两者指向同一文件表项。关于文件描述符，本方法产生的“目的文件操作对象”的文件描述符一定是当前可用文件描述符中的最小数值。 |
| 公开 静态 apr.返回码 | 复制对象2(apr.文件操作 目的文件操作对象, apr.文件操作 源文件操作对象, apr.内存池 内存池对象) 复制参数“源文件操作对象”为“目的文件操作对象”，即两者指向同一文件表项。关于文件描述符，本方法产生的“目的文件操作对象”的文件描述符是传参时提供的指定描述符。如果“目的文件操作对象”已经指向打开的文件，那么先关闭该描述符再进行复制，如果“目的文件操作对象”和“源文件操作对象”的文件描述符相同，那么不关闭该描述符。 |
| 公开 静态 apr.返回码 | 复制对象3(apr.文件操作 目的文件操作对象, apr.文件操作 源文件操作对象, apr.内存池 内存池对象) 复制参数“源文件操作对象”为“目的文件操作对象”，“目的文件操作对象”使用指定的内存池。调用本方法后参数“源文件操作对象”可能不能再被使用。 |
| 公开 apr.返回码 | 定位(整数 位置, 文本 偏移) 定位文件内的位置。 |
| 公开 静态 apr.返回码 | 创建匿名管道(apr.文件操作 读端, apr.文件操作 写端, apr.内存池 内存池对象) 创建半双工管道，通常的用法是创建管道后“派生进程”。 |
| 公开 静态 apr.返回码 | 创建有名管道(文本 文件名, 整数 文件权限, apr.内存池 内存池对象) 本方法目前仅在UNIX平台上实现，其它平台调用返回“ENOTIMPL”。它在指定的路径下建立FIFO文件，常用于进程间共享数据，一个进程打开FIFO文件进行写操作，而另一个进程进行读操作。 |
| 公开 文本 | 取管道终止时间() 本方法设置返回码，成功返回时间，失败返回空文本。 |
| 公开 apr.返回码 | 置管道终止时间(文本 停止时间) |
| 公开 apr.返回码 | 上锁(整数 类型) |
| 公开 apr.返回码 | 解锁() 解锁文件，或调用“关闭”方法强制解锁。 |
| 公开 文本 | 取文件名() 本方法设置返回码，成功返回文件名，失败返回空文本。 |
| 公开 文本 | 取数据(文本 键名) 本方法设置返回码，成功返回键名对应的键值，失败返回空文本。 |
| 公开 apr.返回码 | 置数据(文本 键值, 文本 键名, apr.内存池 内存池对象) 设置键名与键值。本方法将复制数据到指定的内存池对象。 |
| 公开 静态 apr.返回码 | 置权限(文本 文件名, 整数 权限) |
| 公开 静态 apr.返回码 | 置属性(文本 文件名, 整数 属性, 整数 掩码, apr.内存池 内存池对象) 如果系统未实现该接口，将返回ENOTIMPL |
| 公开 静态 apr.返回码 | 置修改时间(文本 文件名, 文本 修改时间, apr.内存池 内存池对象) 设置文件修改时间。 |
| 公开 apr.文件信息 | 取文件状态(整数 标志) 与“取文件状态”方法相同，本方法针对一个己打开的文件。本方法设置返回码，成功返回文件信息对象，失败返回空对象。 |
| 公开 静态 apr.文件信息 | 取文件状态(文本 文件名, 整数 标志, apr.内存池 内存池对象) 本方法与“取文件状态”方法相同，本方法针对任意指定的文件。本方法设置返回码，成功返回文件信息对象，失败返回空对象。 |
| 公开 apr.返回码 | 截取内容(整数 长度) |
| 公开 整数 | 取得打开标志() 方法返回当前文件操作对象的打开标志，见枚举“文件打开标志”。 |
| 公开 apr.返回码 | 打开临时文件(文本 文件名, apr.内存池 内存池对象, 整数 打开标志 = 0) 以唯一的文件名创建一个文件并打开，只有当前用户才能访问这个临时文件，打开标志中有“删除”的文件会在关闭后删除文件。 |
| 公开 静态 文本 |
本方法设置返回码，成功返回目录名，失败返回空文本。 |
| 从 系统.对象 继承的方法 |
| 比较类型, 是否实现, 取类名, 发送事件, 等于, 比较, 到文本, 比较引用 |
块数据最大长度。
打开指定文件，本方法设置返回码。
打开指定文件。
参数：
文件名 - 路径加文件名。
打开标志 - 见枚举“文件打开标志”。
权限 - 见枚举“权限”。
内存池对象
关闭己打开文件。
删除指定文件。
参数：
文件名 - 路径加文件名。
内存池对象
对指定文件重命名。
参数：
源文件名 - 路径加文件名。
目的文件名 - 路径加文件名。如果目的文件路径与源文件路径不同，本方法复制源文件至目的路径。
内存池对象
复制文件，如果目的文件不存在将创建新文件。
参数：
源文件名 - 路径加文件名。
目的文件名 - 路径加文件名。
权限 - 见枚举“权限”。
内存池对象
将源文件内容追加到目的文件中，如果目的文件不存在将创建新文件。
参数：
源文件名 - 路径加文件名。
目的文件名 - 路径加文件名。
权限 - 见枚举“权限”，推荐使用“拷贝文件”。
内存池对象
如果到文件尾，返回枚举“返回值选项”的“EOF”，否则返回“SUCCESS”。
参数：
内存池对象
参数：
内存池对象
参数：
内存池对象
如果使用本方法读入大量的数据。如果到文件尾，返回枚举“返回值选项”的“EOF”。本方法设置返回码，成功返回读取的字节集，失败返回空字节集。
参数：
读取长度 - 要读取的字节集长度，单位为字节。
如果使用本方法写出大量的数据。本方法设置返回码，本方法成功返回已写出长度（单位为字节），失败返回-1。
参数：
字节集对象 - 要写出的字节集。
本方法可以写出多个缓冲区，也称为集中写，本方法设置返回码，成功返回已写出长度（单位为字节），失败返回-1。
参数：
块数据 - 可输出的数组最大长度为本类静态常量成员“块数据最大长度”。
本方法与“读入”方法类似，支持读入大量的数据。本方法设置返回码，成功返回已读字节集，失败返回空字节集。
参数：
长度 - 要读取长度，单位为字节。
本方法与“写出”方法类似，支持写出大量的数据。本方法设置返回码，成功返回已写出长度（单位为字节），失败返回-1。
参数：
字节集对象
支持写出大量数据和多个缓冲区。本方法设置返回码，成功返回已写出长度（单位为字节），失败返回-1。
参数：
块数据 - 可输出的数组最大长度为本类静态常量成员“块数据最大长度”。
参数：
ASCII码 - 要输出字符的ASCII码。
本方法设置返回码，成功返回读入字符的ASCII码，失败返回-1。
将指定字符返回给流，下次读入时首先读入该字符。
参数：
ASCII码 - 要回退字符的ASCII码。
本方法常用于输出流（以写打开的文件或标准输出流），它将输出该流的缓冲区所有未写出的数据；如果输出流文件操作对象创建后未打开任何流，那么可能导致所有输出流被刷新；如针对输入流情况是未知的。
复制参数“源文件操作对象”为“目的文件操作对象”，即两者指向同一文件表项。关于文件描述符，本方法产生的“目的文件操作对象”的文件描述符一定是当前可用文件描述符中的最小数值。
参数：
目的文件操作对象 - 本参数可以是或不是一个有效的文件操作对象。
源文件操作对象 - 本参数必须是一个有效的文件操作对象（即打开成功）。
内存池对象
复制参数“源文件操作对象”为“目的文件操作对象”，即两者指向同一文件表项。关于文件描述符，本方法产生的“目的文件操作对象”的文件描述符是传参时提供的指定描述符。如果“目的文件操作对象”已经指向打开的文件，那么先关闭该描述符再进行复制，如果“目的文件操作对象”和“源文件操作对象”的文件描述符相同，那么不关闭该描述符。
参数：
目的文件操作对象 - 本参数必须是一个有效的文件操作对象。
源文件操作对象 - 本参数必须是一个有效的文件操作对象。
内存池对象
复制参数“源文件操作对象”为“目的文件操作对象”，“目的文件操作对象”使用指定的内存池。调用本方法后参数“源文件操作对象”可能不能再被使用。
参数：
目的文件操作对象 - 本参数可以是或不是一个有效的文件操作对象，本方法返回后，该参数为“源文件操作对象”的一个拷贝。
源文件操作对象 - 本参数必须是一个有效的文件操作对象。
内存池对象 - 该内存池不能为“源文件操作对象”所属内存池的祖先。
定位文件内的位置。
参数：
位置 - 见枚举“文件定位”。
偏移 - 相对于参数“位置”的字节位置，单位为字节。
创建半双工管道，通常的用法是创建管道后“派生进程”。
参数：
读端 - 方法返回时，本参数为管道读端。
写端 - 方法返回时，本参数为管道写端。
内存池对象
本方法目前仅在UNIX平台上实现，其它平台调用返回“ENOTIMPL”。它在指定的路径下建立FIFO文件，常用于进程间共享数据，一个进程打开FIFO文件进行写操作，而另一个进程进行读操作。
参数：
文件名 - 路径加文件名，该文件必须不存在。
文件权限 - 见枚举“权限”。
内存池对象
本方法设置返回码，成功返回时间，失败返回空文本。
参数：
停止时间 - 单位为微秒数，范围从 -9223372036854775808 到 9223372036854775807，即64位有符号数的范围。如果值小于零，意味着永久性阻塞；如果值等于零，表示不等待。
参数：
类型 - 见枚举“文件锁类型”。
解锁文件，或调用“关闭”方法强制解锁。
本方法设置返回码，成功返回文件名，失败返回空文本。
本方法设置返回码，成功返回键名对应的键值，失败返回空文本。
参数：
键名
设置键名与键值。本方法将复制数据到指定的内存池对象。
参数：
键值 - 要设置的键值。
键名
内存池对象
参数：
文件名
权限 - 见枚举“权限”。
如果系统未实现该接口，将返回ENOTIMPL
参数：
文件名
属性 - 见枚举“文件属性”。
掩码 - 见枚举“文件属性”。
内存池对象
设置文件修改时间。
参数：
文件名
修改时间 - 要设置的文件修改时间。单位为微秒数，范围从 -9223372036854775808到 9223372036854775807，即64位有符号数的范围。自"1970年、UTC（协调世界时 Universal Time Coordinated）、1月1日、00:00:00"起计时的微秒数。
内存池对象
与“取文件状态”方法相同，本方法针对一个己打开的文件。本方法设置返回码，成功返回文件信息对象，失败返回空对象。
参数：
标志 - 见枚举“文件状态选项”。
本方法与“取文件状态”方法相同，本方法针对任意指定的文件。本方法设置返回码，成功返回文件信息对象，失败返回空对象。
参数：
文件名 - 路径加文件名。
标志 - 见枚举“文件状态选项”。
内存池对象
参数：
长度 - 要保留的以字节为单位的偏移长度。
方法返回当前文件操作对象的打开标志，见枚举“文件打开标志”。
以唯一的文件名创建一个文件并打开，只有当前用户才能访问这个临时文件，打开标志中有“删除”的文件会在关闭后删除文件。
参数：
文件名 - 本参数是个以“XXXXXX”结尾的文本，方法会用随机产生的字符串替换“XXXXXX”，如“tmp_XXXXXX”。
内存池对象
打开标志 - 见枚举“ 文件打开标志”，默认以“创建|只读|只写|存在|删除”打开。
本方法设置返回码，成功返回目录名，失败返回空文本。
参数：
内存池对象